<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: SpringContextApplication.html 852 2014-03-19 16:40:39Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.vaadin;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.vaadin.Application;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.io.IOException;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.io.ObjectInputStream;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.io.Serializable;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.concurrent.atomic.AtomicLong;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import javax.servlet.ServletContext;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.springframework.beans.factory.config.BeanFactoryPostProcessor;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.springframework.context.ApplicationContext;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.springframework.context.ApplicationListener;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.springframework.context.event.ContextRefreshedEvent;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.springframework.context.event.SourceFilteringListener;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.springframework.web.context.ConfigurableWebApplicationContext;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.springframework.web.context.WebApplicationContext;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.springframework.web.context.support.WebApplicationContextUtils;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.springframework.web.context.support.XmlWebApplicationContext;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Vaadin application implementation that manages an associated Spring {@link WebApplicationContext}.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;h3&gt;Overview&lt;/h3&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Each Vaadin application instance is given its own Spring application context, and all such<a name="line.36"></a>
<span class="sourceLineNo">037</span> * application contexts share the same parent context, which is the one associated with the overal servlet web context<a name="line.37"></a>
<span class="sourceLineNo">038</span> * (i.e., the one created by Spring's {@link org.springframework.web.context.ContextLoaderListener ContextLoaderListener}).<a name="line.38"></a>
<span class="sourceLineNo">039</span> * A context is created when a new Vaadin application instance is initialized, and destroyed when it is closed.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;/p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * This setup is analogous to how Spring's {@link org.springframework.web.servlet.DispatcherServlet DispatcherServlet}<a name="line.43"></a>
<span class="sourceLineNo">044</span> * creates per-servlet application contexts that are children of the overall servlet web context.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;/p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;h3&gt;Application Context XML File Location&lt;/h3&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;p&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * For each Vaadin application {@code com.example.FooApplication} that subclasses this class, there should exist an XML<a name="line.50"></a>
<span class="sourceLineNo">051</span> * file named {@code FooApplication.xml} in the {@code WEB-INF/} directory that defines the per-Vaadin application Spring<a name="line.51"></a>
<span class="sourceLineNo">052</span> * application context. This naming scheme {@linkplain #getApplicationName can be overriden}, or explicit config file<a name="line.52"></a>
<span class="sourceLineNo">053</span> * location(s) can be specified by setting the {@link #VAADIN_CONTEXT_LOCATION_PARAMETER} servlet parameter.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;/p&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> *<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;h3&gt;Vaadin Application as BeanFactory singleton&lt;/h3&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * This {@link SpringContextApplication} instance can itself be exposed in, and configured by, the associated Spring<a name="line.59"></a>
<span class="sourceLineNo">060</span> * application context. Simply create a bean definition that invokes {@link ContextApplication#get}:<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> *  &amp;lt;bean id="myVaadinApplication" class="org.dellroad.stuff.vaadin.ContextApplication" factory-method="get"/&amp;gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> *<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;p&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * This then allows you to autowire the {@link SpringContextApplication} and other UI components together, e.g.:<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> *  public class MyApplication extends SpringContextApplication {<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> *      &amp;#64;Autowired<a name="line.70"></a>
<span class="sourceLineNo">071</span> *      private MainPanel mainPanel;<a name="line.71"></a>
<span class="sourceLineNo">072</span> *<a name="line.72"></a>
<span class="sourceLineNo">073</span> *      &amp;#64;Override<a name="line.73"></a>
<span class="sourceLineNo">074</span> *      public void initSpringApplication(ConfigurableWebApplicationContext context) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> *          Window mainWindow = new Window("MyApplication", this.mainPanel);<a name="line.75"></a>
<span class="sourceLineNo">076</span> *          this.setMainWindow(mainWindow);<a name="line.76"></a>
<span class="sourceLineNo">077</span> *      }<a name="line.77"></a>
<span class="sourceLineNo">078</span> *<a name="line.78"></a>
<span class="sourceLineNo">079</span> *      ...<a name="line.79"></a>
<span class="sourceLineNo">080</span> *  }<a name="line.80"></a>
<span class="sourceLineNo">081</span> *<a name="line.81"></a>
<span class="sourceLineNo">082</span> *  &amp;#64;Component<a name="line.82"></a>
<span class="sourceLineNo">083</span> *  public class MainPanel extends VerticalLayout {<a name="line.83"></a>
<span class="sourceLineNo">084</span> *<a name="line.84"></a>
<span class="sourceLineNo">085</span> *      &amp;#64;Autowired<a name="line.85"></a>
<span class="sourceLineNo">086</span> *      private MyApplication application;<a name="line.86"></a>
<span class="sourceLineNo">087</span> *<a name="line.87"></a>
<span class="sourceLineNo">088</span> *      ...<a name="line.88"></a>
<span class="sourceLineNo">089</span> *  }<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;/p&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> *<a name="line.92"></a>
<span class="sourceLineNo">093</span> * &lt;p&gt;<a name="line.93"></a>
<span class="sourceLineNo">094</span> * Even if you don't explicitly define the {@link SpringContextApplication} bean in your Spring application context,<a name="line.94"></a>
<span class="sourceLineNo">095</span> * it will still be available as a dependency for autowiring into other beans (this is accomplished using<a name="line.95"></a>
<span class="sourceLineNo">096</span> * {@link ConfigurableListableBeanFactory#registerResolvableDependency<a name="line.96"></a>
<span class="sourceLineNo">097</span> * ConfigurableListableBeanFactory.registerResolvableDependency()}). Of course, in this case the<a name="line.97"></a>
<span class="sourceLineNo">098</span> * {@link SpringContextApplication} bean won't itself be autowired or configured.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &lt;/p&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span> *<a name="line.100"></a>
<span class="sourceLineNo">101</span> * &lt;h3&gt;&lt;code&gt;@VaadinConfigurable&lt;/code&gt; Beans&lt;/h3&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * &lt;p&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span> * It is also possible to configure beans outside of this application context using AOP, so that any invocation of<a name="line.104"></a>
<span class="sourceLineNo">105</span> * {@code new FooBar()}, where the class {@code FooBar} is marked {@link VaadinConfigurable @VaadinConfigurable},<a name="line.105"></a>
<span class="sourceLineNo">106</span> * will automagically cause the new {@code FooBar} object to be configured by the application context associated with<a name="line.106"></a>
<span class="sourceLineNo">107</span> * the {@linkplain ContextApplication#get() currently running application instance}. In effect, this does for<a name="line.107"></a>
<span class="sourceLineNo">108</span> * Vaadin application beans what Spring's {@link org.springframework.beans.factory.annotation.Configurable @Configurable}<a name="line.108"></a>
<span class="sourceLineNo">109</span> * does for regular beans.<a name="line.109"></a>
<span class="sourceLineNo">110</span> * &lt;/p&gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span> *<a name="line.111"></a>
<span class="sourceLineNo">112</span> * &lt;p&gt;<a name="line.112"></a>
<span class="sourceLineNo">113</span> * Note however that Spring {@linkplain org.springframework.beans.factory.DisposableBean#destroy destroy methods}<a name="line.113"></a>
<span class="sourceLineNo">114</span> * will not be invoked on application close for these beans, since their lifecycle is controlled outside of the<a name="line.114"></a>
<span class="sourceLineNo">115</span> * Spring application context (this is also the case with<a name="line.115"></a>
<span class="sourceLineNo">116</span> * {@link org.springframework.beans.factory.annotation.Configurable @Configurable} beans). Instead, these beans<a name="line.116"></a>
<span class="sourceLineNo">117</span> * can register as a {@link ContextApplication.CloseListener} for shutdown notification.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * &lt;/p&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span> *<a name="line.119"></a>
<span class="sourceLineNo">120</span> * &lt;p&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span> * For the this annotation to do anything, {@link VaadinConfigurable @VaadinConfigurable} classes must be woven<a name="line.121"></a>
<span class="sourceLineNo">122</span> * (either at build time or runtime) using the<a name="line.122"></a>
<span class="sourceLineNo">123</span> * &lt;a href="http://www.eclipse.org/aspectj/doc/released/faq.php#compiler"&gt;AspectJ compiler&lt;/a&gt; with the<a name="line.123"></a>
<span class="sourceLineNo">124</span> * {@code VaadinConfigurableAspect} aspect (included in the &lt;code&gt;dellroad-stuff&lt;/code&gt; JAR file).<a name="line.124"></a>
<span class="sourceLineNo">125</span> * &lt;/p&gt;<a name="line.125"></a>
<span class="sourceLineNo">126</span> *<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @see ContextApplication#get<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @see &lt;a href="https://github.com/archiecobbs/dellroad-stuff-vaadin-spring-demo3"&gt;Example Code on GitHub&lt;/a&gt;<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span>@SuppressWarnings("serial")<a name="line.130"></a>
<span class="sourceLineNo">131</span>public abstract class SpringContextApplication extends ContextApplication {<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>    /**<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * Optional servlet initialization parameter (&lt;code&gt;{@value #VAADIN_CONTEXT_LOCATION_PARAMETER}&lt;/code&gt;) used to specify<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * the location(s) of the application context XML file(s). Multiple XML files may be separated by whitespace.<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * If this parameter is not defined, then the XML file location is built using {@code /WEB-INF/} as a prefix,<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * the string from {@link #getApplicationName}, and {@code .xml} as a suffix.<a name="line.137"></a>
<span class="sourceLineNo">138</span>     */<a name="line.138"></a>
<span class="sourceLineNo">139</span>    public static final String VAADIN_CONTEXT_LOCATION_PARAMETER = "vaadinContextConfigLocation";<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>    private static final AtomicLong UNIQUE_INDEX = new AtomicLong();<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>    private transient ConfigurableWebApplicationContext context;<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>    /**<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * Get this instance's associated Spring application context.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     */<a name="line.147"></a>
<span class="sourceLineNo">148</span>    public ConfigurableWebApplicationContext getApplicationContext() {<a name="line.148"></a>
<span class="sourceLineNo">149</span>        return this.context;<a name="line.149"></a>
<span class="sourceLineNo">150</span>    }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span>    /**<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * Get the {@link SpringContextApplication} instance associated with the current thread or throw an exception if there is none.<a name="line.153"></a>
<span class="sourceLineNo">154</span>     *<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * &lt;p&gt;<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * Works just like {@link ContextApplication#get()} but returns this narrower type.<a name="line.156"></a>
<span class="sourceLineNo">157</span>     * &lt;/p&gt;<a name="line.157"></a>
<span class="sourceLineNo">158</span>     *<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * @return the {@link SpringContextApplication} associated with the current thread<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * @throws IllegalStateException if the current thread is not servicing a Vaadin web request<a name="line.160"></a>
<span class="sourceLineNo">161</span>     *  or the current Vaadin {@link com.vaadin.Application} is not a {@link SpringContextApplication}<a name="line.161"></a>
<span class="sourceLineNo">162</span>     */<a name="line.162"></a>
<span class="sourceLineNo">163</span>    public static SpringContextApplication get() {<a name="line.163"></a>
<span class="sourceLineNo">164</span>        return ContextApplication.get(SpringContextApplication.class);<a name="line.164"></a>
<span class="sourceLineNo">165</span>    }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>    /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * Initializes the associated {@link ConfigurableWebApplicationContext}.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * &lt;p&gt;<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * After initializing the associated Spring application context, this method delegates to {@link #initSpringApplication}.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     */<a name="line.172"></a>
<span class="sourceLineNo">173</span>    @Override<a name="line.173"></a>
<span class="sourceLineNo">174</span>    protected final void initApplication() {<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span>        // Load the context<a name="line.176"></a>
<span class="sourceLineNo">177</span>        this.loadContext();<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span>        // Initialize subclass<a name="line.179"></a>
<span class="sourceLineNo">180</span>        this.initSpringApplication(context);<a name="line.180"></a>
<span class="sourceLineNo">181</span>    }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span>    /**<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * Initialize the application. Sub-classes of {@link SpringContextApplication} must implement this method.<a name="line.184"></a>
<span class="sourceLineNo">185</span>     *<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * @param context the associated {@link WebApplicationContext} just created and refreshed<a name="line.186"></a>
<span class="sourceLineNo">187</span>     * @see #destroySpringApplication<a name="line.187"></a>
<span class="sourceLineNo">188</span>     */<a name="line.188"></a>
<span class="sourceLineNo">189</span>    protected abstract void initSpringApplication(ConfigurableWebApplicationContext context);<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span>    /**<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * Perform any application-specific shutdown work. This will be invoked at shutdown after this Vaadin application and the<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * associated {@link WebApplicationContext} have both been closed.<a name="line.193"></a>
<span class="sourceLineNo">194</span>     *<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * &lt;p&gt;<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * The implementation in {@link SpringContextApplication} does nothing. Subclasses may override as necessary.<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * &lt;/p&gt;<a name="line.197"></a>
<span class="sourceLineNo">198</span>     *<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * &lt;p&gt;<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * Note that if a {@link SpringContextApplication} instance is exposed in the application context and configured<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * with a Spring {@linkplain org.springframework.beans.factory.DisposableBean#destroy destroy method}, then that<a name="line.201"></a>
<span class="sourceLineNo">202</span>     * method will also be invoked when the application is closed. In such cases overriding this method is not necessary.<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * &lt;/p&gt;<a name="line.203"></a>
<span class="sourceLineNo">204</span>     *<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * @see #initSpringApplication<a name="line.205"></a>
<span class="sourceLineNo">206</span>     */<a name="line.206"></a>
<span class="sourceLineNo">207</span>    protected void destroySpringApplication() {<a name="line.207"></a>
<span class="sourceLineNo">208</span>    }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span>    /**<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * Post-process the given {@link WebApplicationContext} after initial creation but before the initial<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * {@link org.springframework.context.ConfigurableApplicationContext#refresh refresh()}.<a name="line.212"></a>
<span class="sourceLineNo">213</span>     *<a name="line.213"></a>
<span class="sourceLineNo">214</span>     * &lt;p&gt;<a name="line.214"></a>
<span class="sourceLineNo">215</span>     * The implementation in {@link SpringContextApplication} does nothing. Subclasses may override as necessary.<a name="line.215"></a>
<span class="sourceLineNo">216</span>     * &lt;/p&gt;<a name="line.216"></a>
<span class="sourceLineNo">217</span>     *<a name="line.217"></a>
<span class="sourceLineNo">218</span>     * @param context the associated {@link WebApplicationContext} just refreshed<a name="line.218"></a>
<span class="sourceLineNo">219</span>     * @see #onRefresh<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * @see ConfigurableWebApplicationContext#refresh()<a name="line.220"></a>
<span class="sourceLineNo">221</span>     */<a name="line.221"></a>
<span class="sourceLineNo">222</span>    protected void postProcessWebApplicationContext(ConfigurableWebApplicationContext context) {<a name="line.222"></a>
<span class="sourceLineNo">223</span>    }<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span>    /**<a name="line.225"></a>
<span class="sourceLineNo">226</span>     * Perform any application-specific work after a successful application context refresh.<a name="line.226"></a>
<span class="sourceLineNo">227</span>     *<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * &lt;p&gt;<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * The implementation in {@link SpringContextApplication} does nothing. Subclasses may override as necessary.<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * &lt;/p&gt;<a name="line.230"></a>
<span class="sourceLineNo">231</span>     *<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * @param context the associated {@link WebApplicationContext} just refreshed<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * @see #postProcessWebApplicationContext<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * @see org.springframework.context.ConfigurableApplicationContext#refresh<a name="line.234"></a>
<span class="sourceLineNo">235</span>     */<a name="line.235"></a>
<span class="sourceLineNo">236</span>    protected void onRefresh(ApplicationContext context) {<a name="line.236"></a>
<span class="sourceLineNo">237</span>    }<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span>    /**<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * Get the name for this application. This is used as the name of the XML file in {@code WEB-INF/} that<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * defines the Spring application context associated with this instance, unless the<a name="line.241"></a>
<span class="sourceLineNo">242</span>     * {@link #VAADIN_CONTEXT_LOCATION_PARAMETER} servlet parameter is set.<a name="line.242"></a>
<span class="sourceLineNo">243</span>     *<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * &lt;p&gt;<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * The implementation in {@link SpringContextApplication} returns this instance's class'<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * {@linkplain Class#getSimpleName simple name}.<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * &lt;/p&gt;<a name="line.247"></a>
<span class="sourceLineNo">248</span>     */<a name="line.248"></a>
<span class="sourceLineNo">249</span>    protected String getApplicationName() {<a name="line.249"></a>
<span class="sourceLineNo">250</span>        return this.getClass().getSimpleName();<a name="line.250"></a>
<span class="sourceLineNo">251</span>    }<a name="line.251"></a>
<span class="sourceLineNo">252</span><a name="line.252"></a>
<span class="sourceLineNo">253</span>// ApplicationContext setup<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span>    private void loadContext() {<a name="line.255"></a>
<span class="sourceLineNo">256</span><a name="line.256"></a>
<span class="sourceLineNo">257</span>        // Logging<a name="line.257"></a>
<span class="sourceLineNo">258</span>        this.log.info("loading application context for Vaadin application " + this.getApplicationName());<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span>        // Sanity check<a name="line.260"></a>
<span class="sourceLineNo">261</span>        if (this.context != null)<a name="line.261"></a>
<span class="sourceLineNo">262</span>            throw new IllegalStateException("context already loaded");<a name="line.262"></a>
<span class="sourceLineNo">263</span><a name="line.263"></a>
<span class="sourceLineNo">264</span>        // Find the application context associated with the servlet; it will be the parent<a name="line.264"></a>
<span class="sourceLineNo">265</span>        String contextPath = ContextApplication.currentRequest().getContextPath() + "/";<a name="line.265"></a>
<span class="sourceLineNo">266</span>        ServletContext servletContext = ContextApplication.currentRequest().getSession().getServletContext();<a name="line.266"></a>
<span class="sourceLineNo">267</span>        WebApplicationContext parent = WebApplicationContextUtils.getWebApplicationContext(servletContext);<a name="line.267"></a>
<span class="sourceLineNo">268</span><a name="line.268"></a>
<span class="sourceLineNo">269</span>        // Create and configure a new application context for this Application instance<a name="line.269"></a>
<span class="sourceLineNo">270</span>        this.context = new XmlWebApplicationContext();<a name="line.270"></a>
<span class="sourceLineNo">271</span>        this.context.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX<a name="line.271"></a>
<span class="sourceLineNo">272</span>          + contextPath + this.getApplicationName() + "-" + UNIQUE_INDEX.incrementAndGet());<a name="line.272"></a>
<span class="sourceLineNo">273</span>        if (parent != null)<a name="line.273"></a>
<span class="sourceLineNo">274</span>            context.setParent(parent);<a name="line.274"></a>
<span class="sourceLineNo">275</span>        if (servletContext != null)<a name="line.275"></a>
<span class="sourceLineNo">276</span>            context.setServletContext(servletContext);<a name="line.276"></a>
<span class="sourceLineNo">277</span>        //context.setServletConfig(??);<a name="line.277"></a>
<span class="sourceLineNo">278</span>        this.context.setNamespace(this.getApplicationName());<a name="line.278"></a>
<span class="sourceLineNo">279</span><a name="line.279"></a>
<span class="sourceLineNo">280</span>        // Set explicit config location(s) if set by parameter<a name="line.280"></a>
<span class="sourceLineNo">281</span>        String configLocationValue = this.getProperty(VAADIN_CONTEXT_LOCATION_PARAMETER);<a name="line.281"></a>
<span class="sourceLineNo">282</span>        if (configLocationValue != null)<a name="line.282"></a>
<span class="sourceLineNo">283</span>            this.context.setConfigLocation(configLocationValue);<a name="line.283"></a>
<span class="sourceLineNo">284</span><a name="line.284"></a>
<span class="sourceLineNo">285</span>        // Register listener so we can notify subclass on refresh events<a name="line.285"></a>
<span class="sourceLineNo">286</span>        this.context.addApplicationListener(new SourceFilteringListener(this.context, new RefreshListener()));<a name="line.286"></a>
<span class="sourceLineNo">287</span><a name="line.287"></a>
<span class="sourceLineNo">288</span>        // Register this instance as an implicitly resolvable dependency<a name="line.288"></a>
<span class="sourceLineNo">289</span>        this.context.addBeanFactoryPostProcessor(new BeanFactoryPostProcessor() {<a name="line.289"></a>
<span class="sourceLineNo">290</span>            @Override<a name="line.290"></a>
<span class="sourceLineNo">291</span>            public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {<a name="line.291"></a>
<span class="sourceLineNo">292</span>                beanFactory.registerResolvableDependency(Application.class, SpringContextApplication.this);<a name="line.292"></a>
<span class="sourceLineNo">293</span>            }<a name="line.293"></a>
<span class="sourceLineNo">294</span>        });<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span>        // Invoke any subclass setup<a name="line.296"></a>
<span class="sourceLineNo">297</span>        this.postProcessWebApplicationContext(context);<a name="line.297"></a>
<span class="sourceLineNo">298</span><a name="line.298"></a>
<span class="sourceLineNo">299</span>        // Refresh context<a name="line.299"></a>
<span class="sourceLineNo">300</span>        this.context.refresh();<a name="line.300"></a>
<span class="sourceLineNo">301</span><a name="line.301"></a>
<span class="sourceLineNo">302</span>        // Get notified of application shutdown so we can shut down the context as well<a name="line.302"></a>
<span class="sourceLineNo">303</span>        this.addListener(new ContextCloseListener());<a name="line.303"></a>
<span class="sourceLineNo">304</span>    }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span>// Serialization<a name="line.306"></a>
<span class="sourceLineNo">307</span><a name="line.307"></a>
<span class="sourceLineNo">308</span>    private void readObject(ObjectInputStream input) throws IOException, ClassNotFoundException {<a name="line.308"></a>
<span class="sourceLineNo">309</span>        input.defaultReadObject();<a name="line.309"></a>
<span class="sourceLineNo">310</span>        this.loadContext();<a name="line.310"></a>
<span class="sourceLineNo">311</span>    }<a name="line.311"></a>
<span class="sourceLineNo">312</span><a name="line.312"></a>
<span class="sourceLineNo">313</span>// Nested classes<a name="line.313"></a>
<span class="sourceLineNo">314</span><a name="line.314"></a>
<span class="sourceLineNo">315</span>    // My refresh listener<a name="line.315"></a>
<span class="sourceLineNo">316</span>    private class RefreshListener implements ApplicationListener&lt;ContextRefreshedEvent&gt;, Serializable {<a name="line.316"></a>
<span class="sourceLineNo">317</span>        @Override<a name="line.317"></a>
<span class="sourceLineNo">318</span>        public void onApplicationEvent(ContextRefreshedEvent event) {<a name="line.318"></a>
<span class="sourceLineNo">319</span>            SpringContextApplication.this.onRefresh(event.getApplicationContext());<a name="line.319"></a>
<span class="sourceLineNo">320</span>        }<a name="line.320"></a>
<span class="sourceLineNo">321</span>    }<a name="line.321"></a>
<span class="sourceLineNo">322</span><a name="line.322"></a>
<span class="sourceLineNo">323</span>    // My close listener<a name="line.323"></a>
<span class="sourceLineNo">324</span>    private class ContextCloseListener implements CloseListener, Serializable {<a name="line.324"></a>
<span class="sourceLineNo">325</span>        @Override<a name="line.325"></a>
<span class="sourceLineNo">326</span>        public void applicationClosed(CloseEvent closeEvent) {<a name="line.326"></a>
<span class="sourceLineNo">327</span>            SpringContextApplication.this.log.info("closing application context associated with Vaadin application "<a name="line.327"></a>
<span class="sourceLineNo">328</span>              + SpringContextApplication.this.getApplicationName());<a name="line.328"></a>
<span class="sourceLineNo">329</span>            SpringContextApplication.this.context.close();<a name="line.329"></a>
<span class="sourceLineNo">330</span>            SpringContextApplication.this.destroySpringApplication();<a name="line.330"></a>
<span class="sourceLineNo">331</span>        }<a name="line.331"></a>
<span class="sourceLineNo">332</span>    }<a name="line.332"></a>
<span class="sourceLineNo">333</span>}<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>




























































</pre>
</div>
</body>
</html>
